<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the startPlayerFromStream method from the FlutterSoundPlayer class, for the Dart programming language.">
  <title>startPlayerFromStream method - FlutterSoundPlayer class - flutter_sound_player library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../../static-assets/github.css?v1">
  <link rel="stylesheet" href="../../static-assets/styles.css?v1">
  <link rel="icon" href="../../static-assets/favicon.png?v1">
  
</head>

<body data-base-href="../../" data-using-base-href="false" class="light-theme">
<div id="overlay-under-drawer"></div>
<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../../index.html">flutter_sound</a></li>
    <li><a href="../../public_flutter_sound_player">public&#47;flutter_sound_player.dart</a></li>
    <li><a href="../../public_flutter_sound_player/FlutterSoundPlayer-class.html">FlutterSoundPlayer</a></li>
    <li class="self-crumb">startPlayerFromStream method</li>
  </ol>
  <div class="self-name">startPlayerFromStream</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button" title="Toggle brightness">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        dark_mode
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        light_mode
      </span>
    </label>
  </div>
</header>
<main>
<div
    id="dartdoc-main-content"
    class="main-content"
    data-above-sidebar="public_flutter_sound_player&#47;FlutterSoundPlayer-class-sidebar.html"
    data-below-sidebar="">
    <div>
<h1><span class="kind-method">startPlayerFromStream</span> method 
</h1></div>

    <section class="multi-line-signature">
      
<span class="returntype"><a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
<span class="name ">startPlayerFromStream</span>(<wbr>{<ol class="parameter-list"> <li><span class="parameter" id="startPlayerFromStream-param-codec"><span>required</span> <span class="type-annotation"><a href="https://pub.dev/documentation/flutter_sound_platform_interface/9.28.0/flutter_sound_platform_interface/Codec.html">Codec</a></span> <span class="parameter-name">codec</span>, </span></li>
<li><span class="parameter" id="startPlayerFromStream-param-interleaved"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">interleaved</span>, </span></li>
<li><span class="parameter" id="startPlayerFromStream-param-numChannels"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">numChannels</span>, </span></li>
<li><span class="parameter" id="startPlayerFromStream-param-sampleRate"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">sampleRate</span>, </span></li>
<li><span class="parameter" id="startPlayerFromStream-param-bufferSize"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">bufferSize</span>, </span></li>
<li><span class="parameter" id="startPlayerFromStream-param-onBufferUnderlow"><span class="type-annotation"><a href="../../public_flutter_sound_player/TWhenFinished.html">TWhenFinished</a>?</span> <span class="parameter-name">onBufferUnderlow</span>, </span></li>
</ol>})

      

    </section>
    
<section class="desc markdown">
  <p>Used to play something from a dart stream</p>
<p>You use this verb instead of <a href="../../public_flutter_sound_player/FlutterSoundPlayer/startPlayer.html">startPlayer</a> when you want to play from a dart stream
or if you want to use one of the three <code>feed()</code> verbs.
For a complete discussion of the play from stream feature,
please look to this <a href="/tau/guides/guides_live_streams.html">small guide</a></p>
<h2 id="parameters">Parameters</h2>
<ul>
<li><strong><em>codec:</em></strong> The only codecs supported are <a href="https://pub.dev/documentation/flutter_sound_platform_interface/9.28.0/flutter_sound_platform_interface/Codec.html">Codec.pcm16</a> and <a href="https://pub.dev/documentation/flutter_sound_platform_interface/9.28.0/flutter_sound_platform_interface/Codec.html">Codec.pcmFloat32</a>. This parameter is mandatory.</li>
<li><strong><em>interleaved:</em></strong> is a boolean specifying if the data that you will fee will be in an interleaved or a plan mode.
 This parameter is mandatory.</li>
<li><strong><em>numChannels:</em></strong> is the number of channels of the audio data that you will provide. This parameter is mandatory.</li>
<li><strong><em>sampleRate:</em></strong> is the sample rate used by your data. This parameter is mandatory.</li>
<li><strong><em>bufferSize:</em></strong> is the size of the internal buffers. Most of the time you don't specify this parameter and use the default value.</li>
<li><strong><em>onBufferUnderflow</em></strong> is a callback which is fired when we run short on buffers. Perhaps because the playback is finished or because it has not fully started.</li>
</ul>
<p>Please look to <a href="/tau/guides/guides_live_streams.html">the following notice</a></p>
<h2 id="return">Return</h2>
<p>Returns a Future which is completed when the function is done.</p>
<h2 id="example">Example</h2>
<p>You can look to the three provided examples :</p>
<ul>
<li><a href="/tau/examples/ex_playback_from_stream_1.html">This example</a> shows how to play live data, without Back Pressure from Flutter Sound</li>
<li><a href="/tau/examples/ex_playback_from_stream_2.html">This example</a> shows how to play Live data, with Back Pressure from Flutter Sound</li>
<li><a href="/tau/examples/ex_streams.html">This example</a> shows how to record and playback from streams.</li>
</ul>
<p><strong><em>Example 1:</em></strong></p>
<pre class="language-dart"><code class="language-dart">await myPlayer.startPlayerFromStream(codec: Codec.pcm16, numChannels: 1, sampleRate: 48000);

await myPlayer.feedF32FromStream(aBuffer);
await myPlayer.feedF32FromStream(anotherBuffer);
await myPlayer.feedF32FromStream(myOtherBuffer);

await myPlayer.stopPlayer();
</code></pre>
<p><strong><em>Example 2:</em></strong></p>
<pre class="language-dart"><code class="language-dart">await myPlayer.startPlayerFromStream(codec: Codec.pcm16, numChannels: 1, sampleRate: 48000);

myPlayer.float32Sink.add(aBuffer));
myPlayer.float32Sink.add(anotherBuffer);
myPlayer.float32Sink.add(myOtherBuffer);
</code></pre>
<h2 id="see-also">See also</h2>
<ul>
<li><a href="../../public_flutter_sound_player/FlutterSoundPlayer/startPlayer.html">startPlayer()</a></li>
<li><a href="../../public_flutter_sound_player/FlutterSoundPlayer/stopPlayer.html">stopPlayer()</a></li>
</ul>
</section>


    
<section class="summary source-code" id="source">
  <h2><span>Implementation</span></h2>
  <pre class="language-dart"><code class="language-dart">Future&lt;void&gt; startPlayerFromStream({
  required Codec codec, &#47;&#47; = Codec.pcmFloat32,
  required bool interleaved, &#47;&#47; = false,
  required int numChannels, &#47;&#47; = 2,
  required int sampleRate, &#47;&#47; = 48000,
  required int bufferSize, &#47;&#47; = 1024,
  TWhenFinished? onBufferUnderlow,
}) async {
  await _lock.synchronized(() async {
    await _startPlayerFromStream(
      codec: codec,
      interleaved: interleaved,
      sampleRate: sampleRate,
      numChannels: numChannels,
      bufferSize: bufferSize,
      onBufferUnderflow: onBufferUnderlow,
    );
  });
}</code></pre>
</section>


  </div> <!-- /.main-content -->
  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="../../index.html">flutter_sound</a></li>
    <li><a href="../../public_flutter_sound_player">flutter_sound_player</a></li>
    <li><a href="../../public_flutter_sound_player/FlutterSoundPlayer-class.html">FlutterSoundPlayer</a></li>
    <li class="self-crumb">startPlayerFromStream method</li>
</ol>

    <h5>FlutterSoundPlayer class</h5>
    <div id="dartdoc-sidebar-left-content"></div>
  </div><!--/.sidebar-offcanvas-->
  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
</div><!--/.sidebar-offcanvas-->
</main>
<footer>
  <span class="no-break">
    flutter_sound
      9.28.0
  </span>
  
</footer>


<script src="../../static-assets/highlight.pack.js?v1"></script>
<script src="../../static-assets/docs.dart.js"></script>

</body>
</html>

